Skip to main content

Metadata Details

Service: Metadata

  1. Base URL:
    https://api.seirpk.com/mrest/metadata
  1. Description
    The Metadata Service is a critical API for syncing data within the SEIR mobile application. This service provides essential data related to:

  • Locations

  • Vaccination Centers

  • Programs

  • Equipment (e.g., fridge tags)

  • Vaccines and Vaccine Pre-requisites

  • Vaccine Stock

  • Location Types

  • User Roles and Permissions

  • Vaccinator Users

    This API is integral for the functioning of the mobile app, as syncing the latest metadata is necessary for accurate operation and data management.

  1. Request Format

    All requests must be sent using HTTP GET method.

  1. Response Format
  • Content-Type: application/json
  • Success Response: A 200 OK HTTP status code with the appropriate JSON response body.
  • Failure Response: A 200 OK HTTP status code with no JSON content, only a code value of 2 to indicate failure due to an incomplete operation or unknown reasons.
  • Server Error Response: A 500 Internal Server Error HTTP status code when a server-side error occurs.

  1. Dependencies​

    The Metadata API fetches data from multiple related tables in the system, including:

  • Users

  • Vaccinators

  • Locations and Location-Related Tables

  • Roles and Role Permissions

  • Vaccines and Vaccine-Related Tables

  • Stock Management

    Each of these components is crucial for proper synchronization and the overall functionality of the SEIR application.

  1. Schema​

    Below are the key entities utilized by the Metadata Service:

    1. Location​
    2. LocationType​
    3. VaccinationCenter​
    4. Vaccine​
    5. VaccineGap​
    6. VaccinePrerequisite​
    7. User​
    8. Program​
    9. Role​
    10. VaccinatorDailyStock​
    11. Equipment​
    12. EquipmentType​
    13. Organization​